Vcenter ServiceLocator

Vcenter ServiceLocator

This data object type specifies the information of a service endpoint as well as the parameters needed to locate and login to to the service endpoint.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "instance_uuid": "string",
    "url": "string",
    "credential": {
        "type": "string",
        "username_password": {
            "user_name": "string",
            "password": "string"
        },
        "saml_token": "string"
    },
    "ssl_thumbprint": "string",
    "ssl_certificate": "string"
}

string

instance_uuid

Required

Unique ID of the instance to which the service belongs. For instances that support the vSphere API, this is the same as the value found in vim.AboutInfo#instanceUuid.

This property was added in vSphere API 9.0.0.0.

string

url

Required

URL used to access the service endpoint.

This property was added in vSphere API 9.0.0.0.

credential

Required

Credential to establish the connection and login to the service.

This property was added in vSphere API 9.0.0.0.

string

ssl_thumbprint

Optional

The sslThumbprint of the service endpoint. Superseded by Vcenter ServiceLocator.ssl_certificate. Note: If both sslThumbprint and sslCertificate are set, sslThumbprint must correspond to the sslCertificate.

This property was added in vSphere API 9.0.0.0.

if missing or null, then sslCertificate will be checked. If both these fields are missing or null, then thumbprint from first connection will be trusted.

string

ssl_certificate

Optional

The SSL certificate of the service endpoint in PEM format. A replacement for Vcenter ServiceLocator.ssl_thumbprint. Note: If both sslThumbprint and sslCertificate are set, sslThumbprint must correspond to the sslCertificate.

This property was added in vSphere API 9.0.0.0.

if missing or null, then remote service endpoint certificate will not be verified upon connection.